<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">		
<html>								
<head>								
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">	
	<title> $link</title>	
	<style type="text/css">		
	h1 {							
		font-size:28px;				
		font-family: verdana		
	}								
	p.otherNames{					
		font-size:20px;				
		font-family: verdana;		
	}								
	p.desc {						
		font-size:12px;				
		font-family: verdana;		
	}								
	p.doc {							
		margin-left:2cm;			
	}								
	td.doc {						
		font-size:12px;				
		font-family: verdana;		
		vertical-align:text-top;	
		padding-top: 6px;			
		padding-bottom: 12px;		
	}								
	tr.title {						
		font-family: verdana;		
		font-size:20px;				
		font-weight:bold;			
		background-color: #CCCCFF ;	
	}								
	code.simpledesc {				
		font-size:15px;				
		color: #000099; 			
	}								
	</style>						
</head>							
<body>											
<h1> $link</h1>	
<p class="desc">								
This object provides all information about an entity link<br>
Each link is retrieved from the entity class <br>
<br>
<br>
<br>
<b>Example : </b><br>
<code>
&nbsp;&nbsp;&nbsp;<br>
&nbsp;&nbsp;&nbsp;#foreach( $link in $entity.selectedLinks )<br>
&nbsp;&nbsp;&nbsp;    private $link.formatedType(10) $link.formatedName(12);<br>
&nbsp;&nbsp;&nbsp;#end<br>
</code>
</p>		
<table width="100%" border="1" cellspacing="0">		
<TR class="title">										
  <TD>Attributes and methods</TD>			
</TR>		
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.cardinality : String</B> </CODE>
<p class="doc">
Returns the cardinality of the link <br>
eg : 'OneToMany', 'ManyToOne', 'OneToOne', 'ManyToMany'<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.cascade : String</B> </CODE>
<p class="doc">
Returns the 'cascade type' ( 'ALL', 'MERGE', 'PERSIST', 'REFRESH', 'REMOVE' )<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.fetch : String</B> </CODE>
<p class="doc">
Returns the 'fetch type' ( 'DEFAULT' or 'EAGER' or 'LAZY' )<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.formatedName(int n) : String</B> </CODE>
<p class="doc">
Returns the link's name with n trailing blanks <br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>n</b> : the number of blanks to be added at the end of the name<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.formatedType(int n) : String</B> </CODE>
<p class="doc">
Returns the link's type with n trailing blanks <br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>n</b> : the number of blanks to be added at the end of the name<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.getter : String</B> </CODE>
<p class="doc">
Returns the Java getter for the link e.g. 'getPerson' for link 'person' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.hasJoinColumns() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link has 'join columns' (at least one)<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.hasJoinTable() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link has a 'join table'<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.id : String</B> </CODE>
<p class="doc">
Returns the unique id of the link in the repository (id used by the tool)<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCardinalityManyToMany() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link has a 'ManyToMany' cardinality<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCardinalityManyToOne() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link has a 'ManyToOne' cardinality<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCardinalityOneToMany() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link has a 'OneToMany' cardinality<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCardinalityOneToOne() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link has a 'OneToOne' cardinality<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCascadeALL() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'cascade type' is 'ALL' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCascadeMERGE() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'cascade type' is 'MERGE' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCascadePERSIST() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'cascade type' is 'PERSIST' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCascadeREFRESH() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'cascade type' is 'REFRESH' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isCascadeREMOVE() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'cascade type' is 'REMOVE' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isFetchDEFAULT() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'fetch type' is 'DEFAULT' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isFetchEAGER() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'fetch type' is 'EAGER' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isFetchLAZY() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'fetch type' is 'LAZY' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isOptionalFalse() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'optional status' is 'FALSE' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isOptionalTrue() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'optional status' is 'TRUE' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isOptionalUndefined() : boolean</B> </CODE>
<p class="doc">
Returns true if the 'optional status' is 'UNDEFINED' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isOwningSide() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link is the 'Owning Side' of the relationship between 2 entities<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.isSelected() : boolean</B> </CODE>
<p class="doc">
Returns TRUE if the link is selected (ckeckbox ckecked in the GUI)<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.javaName : String</B> </CODE>
<p class="doc">
Returns the Java field name for the link<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.javaTypeFull : String</B> </CODE>
<p class="doc">
Returns the full Java type for the link ( eg 'java.util.List' ) <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.javaTypeShort : String</B> </CODE>
<p class="doc">
Returns the short Java type for the link ( eg 'List' ) <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.joinColumns : String[]</B> </CODE>
<p class="doc">
Returns the 'join columns' for the link <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.joinTable : String</B> </CODE>
<p class="doc">
Returns the 'join table' for the link <br>
Typically for JPA '@JoinTable'<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.jpaAnnotations(int leftMargin) : String</B> </CODE>
<p class="doc">
Returns all the JPA annotations for the link (with a left margin)<br>
<br>
<b>Parameters : </b><br>
&nbsp;&nbsp;&nbsp;<b>leftMargin</b> : the left margin (number of blanks)<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.linkType : String</B> </CODE>
<p class="doc">
Returns the type of the link <br>
eg : List, List<Person>, Person, ...<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.mappedBy : String</B> </CODE>
<p class="doc">
Returns the name of the link in the 'owning side' <br>
Typically for JPA 'mappedBy'<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.optional : String</B> </CODE>
<p class="doc">
Returns the 'optional status' for the link  ( 'TRUE', 'FALSE' or 'UNDEFINED' ) <br>
Typically for JPA 'optional=true/false'<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.setter : String</B> </CODE>
<p class="doc">
Returns the Java setter for the link e.g. 'setPerson' for link 'person' <br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.targetEntity : String</B> </CODE>
<p class="doc">
Returns the type of the entity referenced by the link <br>
<br>
</p>
</TD>
</TR>
<TR>
<TD class="doc" ><CODE class="simpledesc"> <B>.targetTableName : String</B> </CODE>
<p class="doc">
Returns the name of the target table (table referenced by the link)<br>
</p>
</TD>
</TR>
</table>
</body>
</html>
